home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / python2.4 / pickletools.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2005-10-18  |  56KB  |  856 lines

  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.4)
  3.  
  4. '''"Executable documentation" for the pickle module.
  5.  
  6. Extensive comments about the pickle protocols and pickle-machine opcodes
  7. can be found here.  Some functions meant for external use:
  8.  
  9. genops(pickle)
  10.    Generate all the opcodes in a pickle, as (opcode, arg, position) triples.
  11.  
  12. dis(pickle, out=None, memo=None, indentlevel=4)
  13.    Print a symbolic disassembly of a pickle.
  14. '''
  15. __all__ = [
  16.     'dis',
  17.     'genops']
  18. UP_TO_NEWLINE = -1
  19. TAKEN_FROM_ARGUMENT1 = -2
  20. TAKEN_FROM_ARGUMENT4 = -3
  21.  
  22. class ArgumentDescriptor(object):
  23.     __slots__ = ('name', 'n', 'reader', 'doc')
  24.     
  25.     def __init__(self, name, n, reader, doc):
  26.         if not isinstance(name, str):
  27.             raise AssertionError
  28.         self.name = name
  29.         if not (isinstance(n, int) or n >= 0) and n in (UP_TO_NEWLINE, TAKEN_FROM_ARGUMENT1, TAKEN_FROM_ARGUMENT4):
  30.             raise AssertionError
  31.         self.n = n
  32.         self.reader = reader
  33.         if not isinstance(doc, str):
  34.             raise AssertionError
  35.         self.doc = doc
  36.  
  37.  
  38. from struct import unpack as _unpack
  39.  
  40. def read_uint1(f):
  41.     """
  42.     >>> import StringIO
  43.     >>> read_uint1(StringIO.StringIO('\\xff'))
  44.     255
  45.     """
  46.     data = f.read(1)
  47.     if data:
  48.         return ord(data)
  49.     
  50.     raise ValueError('not enough data in stream to read uint1')
  51.  
  52. uint1 = ArgumentDescriptor(name = 'uint1', n = 1, reader = read_uint1, doc = 'One-byte unsigned integer.')
  53.  
  54. def read_uint2(f):
  55.     """
  56.     >>> import StringIO
  57.     >>> read_uint2(StringIO.StringIO('\\xff\\x00'))
  58.     255
  59.     >>> read_uint2(StringIO.StringIO('\\xff\\xff'))
  60.     65535
  61.     """
  62.     data = f.read(2)
  63.     if len(data) == 2:
  64.         return _unpack('<H', data)[0]
  65.     
  66.     raise ValueError('not enough data in stream to read uint2')
  67.  
  68. uint2 = ArgumentDescriptor(name = 'uint2', n = 2, reader = read_uint2, doc = 'Two-byte unsigned integer, little-endian.')
  69.  
  70. def read_int4(f):
  71.     """
  72.     >>> import StringIO
  73.     >>> read_int4(StringIO.StringIO('\\xff\\x00\\x00\\x00'))
  74.     255
  75.     >>> read_int4(StringIO.StringIO('\\x00\\x00\\x00\\x80')) == -(2**31)
  76.     True
  77.     """
  78.     data = f.read(4)
  79.     if len(data) == 4:
  80.         return _unpack('<i', data)[0]
  81.     
  82.     raise ValueError('not enough data in stream to read int4')
  83.  
  84. int4 = ArgumentDescriptor(name = 'int4', n = 4, reader = read_int4, doc = "Four-byte signed integer, little-endian, 2's complement.")
  85.  
  86. def read_stringnl(f, decode = True, stripquotes = True):
  87.     '''
  88.     >>> import StringIO
  89.     >>> read_stringnl(StringIO.StringIO("\'abcd\'\\nefg\\n"))
  90.     \'abcd\'
  91.  
  92.     >>> read_stringnl(StringIO.StringIO("\\n"))
  93.     Traceback (most recent call last):
  94.     ...
  95.     ValueError: no string quotes around \'\'
  96.  
  97.     >>> read_stringnl(StringIO.StringIO("\\n"), stripquotes=False)
  98.     \'\'
  99.  
  100.     >>> read_stringnl(StringIO.StringIO("\'\'\\n"))
  101.     \'\'
  102.  
  103.     >>> read_stringnl(StringIO.StringIO(\'"abcd"\'))
  104.     Traceback (most recent call last):
  105.     ...
  106.     ValueError: no newline found when trying to read stringnl
  107.  
  108.     Embedded escapes are undone in the result.
  109.     >>> read_stringnl(StringIO.StringIO(r"\'a\\n\\\\b\\x00c\\td\'" + "\\n\'e\'"))
  110.     \'a\\n\\\\b\\x00c\\td\'
  111.     '''
  112.     data = f.readline()
  113.     if not data.endswith('\n'):
  114.         raise ValueError('no newline found when trying to read stringnl')
  115.     
  116.     data = data[:-1]
  117.     if stripquotes:
  118.         for q in '\'"':
  119.             if data.startswith(q):
  120.                 if not data.endswith(q):
  121.                     raise ValueError('strinq quote %r not found at both ends of %r' % (q, data))
  122.                 
  123.                 data = data[1:-1]
  124.                 break
  125.                 continue
  126.         else:
  127.             raise ValueError('no string quotes around %r' % data)
  128.     
  129.     if decode:
  130.         data = data.decode('string_escape')
  131.     
  132.     return data
  133.  
  134. stringnl = ArgumentDescriptor(name = 'stringnl', n = UP_TO_NEWLINE, reader = read_stringnl, doc = 'A newline-terminated string.\n\n                   This is a repr-style string, with embedded escapes, and\n                   bracketing quotes.\n                   ')
  135.  
  136. def read_stringnl_noescape(f):
  137.     return read_stringnl(f, decode = False, stripquotes = False)
  138.  
  139. stringnl_noescape = ArgumentDescriptor(name = 'stringnl_noescape', n = UP_TO_NEWLINE, reader = read_stringnl_noescape, doc = 'A newline-terminated string.\n\n                        This is a str-style string, without embedded escapes,\n                        or bracketing quotes.  It should consist solely of\n                        printable ASCII characters.\n                        ')
  140.  
  141. def read_stringnl_noescape_pair(f):
  142.     '''
  143.     >>> import StringIO
  144.     >>> read_stringnl_noescape_pair(StringIO.StringIO("Queue\\nEmpty\\njunk"))
  145.     \'Queue Empty\'
  146.     '''
  147.     return '%s %s' % (read_stringnl_noescape(f), read_stringnl_noescape(f))
  148.  
  149. stringnl_noescape_pair = ArgumentDescriptor(name = 'stringnl_noescape_pair', n = UP_TO_NEWLINE, reader = read_stringnl_noescape_pair, doc = 'A pair of newline-terminated strings.\n\n                             These are str-style strings, without embedded\n                             escapes, or bracketing quotes.  They should\n                             consist solely of printable ASCII characters.\n                             The pair is returned as a single string, with\n                             a single blank separating the two strings.\n                             ')
  150.  
  151. def read_string4(f):
  152.     '''
  153.     >>> import StringIO
  154.     >>> read_string4(StringIO.StringIO("\\x00\\x00\\x00\\x00abc"))
  155.     \'\'
  156.     >>> read_string4(StringIO.StringIO("\\x03\\x00\\x00\\x00abcdef"))
  157.     \'abc\'
  158.     >>> read_string4(StringIO.StringIO("\\x00\\x00\\x00\\x03abcdef"))
  159.     Traceback (most recent call last):
  160.     ...
  161.     ValueError: expected 50331648 bytes in a string4, but only 6 remain
  162.     '''
  163.     n = read_int4(f)
  164.     if n < 0:
  165.         raise ValueError('string4 byte count < 0: %d' % n)
  166.     
  167.     data = f.read(n)
  168.     if len(data) == n:
  169.         return data
  170.     
  171.     raise ValueError('expected %d bytes in a string4, but only %d remain' % (n, len(data)))
  172.  
  173. string4 = ArgumentDescriptor(name = 'string4', n = TAKEN_FROM_ARGUMENT4, reader = read_string4, doc = 'A counted string.\n\n              The first argument is a 4-byte little-endian signed int giving\n              the number of bytes in the string, and the second argument is\n              that many bytes.\n              ')
  174.  
  175. def read_string1(f):
  176.     '''
  177.     >>> import StringIO
  178.     >>> read_string1(StringIO.StringIO("\\x00"))
  179.     \'\'
  180.     >>> read_string1(StringIO.StringIO("\\x03abcdef"))
  181.     \'abc\'
  182.     '''
  183.     n = read_uint1(f)
  184.     if not n >= 0:
  185.         raise AssertionError
  186.     data = f.read(n)
  187.     if len(data) == n:
  188.         return data
  189.     
  190.     raise ValueError('expected %d bytes in a string1, but only %d remain' % (n, len(data)))
  191.  
  192. string1 = ArgumentDescriptor(name = 'string1', n = TAKEN_FROM_ARGUMENT1, reader = read_string1, doc = 'A counted string.\n\n              The first argument is a 1-byte unsigned int giving the number\n              of bytes in the string, and the second argument is that many\n              bytes.\n              ')
  193.  
  194. def read_unicodestringnl(f):
  195.     '''
  196.     >>> import StringIO
  197.     >>> read_unicodestringnl(StringIO.StringIO("abc\\uabcd\\njunk"))
  198.     u\'abc\\uabcd\'
  199.     '''
  200.     data = f.readline()
  201.     if not data.endswith('\n'):
  202.         raise ValueError('no newline found when trying to read unicodestringnl')
  203.     
  204.     data = data[:-1]
  205.     return unicode(data, 'raw-unicode-escape')
  206.  
  207. unicodestringnl = ArgumentDescriptor(name = 'unicodestringnl', n = UP_TO_NEWLINE, reader = read_unicodestringnl, doc = 'A newline-terminated Unicode string.\n\n                      This is raw-unicode-escape encoded, so consists of\n                      printable ASCII characters, and may contain embedded\n                      escape sequences.\n                      ')
  208.  
  209. def read_unicodestring4(f):
  210.     """
  211.     >>> import StringIO
  212.     >>> s = u'abcd\\uabcd'
  213.     >>> enc = s.encode('utf-8')
  214.     >>> enc
  215.     'abcd\\xea\\xaf\\x8d'
  216.     >>> n = chr(len(enc)) + chr(0) * 3  # little-endian 4-byte length
  217.     >>> t = read_unicodestring4(StringIO.StringIO(n + enc + 'junk'))
  218.     >>> s == t
  219.     True
  220.  
  221.     >>> read_unicodestring4(StringIO.StringIO(n + enc[:-1]))
  222.     Traceback (most recent call last):
  223.     ...
  224.     ValueError: expected 7 bytes in a unicodestring4, but only 6 remain
  225.     """
  226.     n = read_int4(f)
  227.     if n < 0:
  228.         raise ValueError('unicodestring4 byte count < 0: %d' % n)
  229.     
  230.     data = f.read(n)
  231.     if len(data) == n:
  232.         return unicode(data, 'utf-8')
  233.     
  234.     raise ValueError('expected %d bytes in a unicodestring4, but only %d remain' % (n, len(data)))
  235.  
  236. unicodestring4 = ArgumentDescriptor(name = 'unicodestring4', n = TAKEN_FROM_ARGUMENT4, reader = read_unicodestring4, doc = 'A counted Unicode string.\n\n                    The first argument is a 4-byte little-endian signed int\n                    giving the number of bytes in the string, and the second\n                    argument-- the UTF-8 encoding of the Unicode string --\n                    contains that many bytes.\n                    ')
  237.  
  238. def read_decimalnl_short(f):
  239.     '''
  240.     >>> import StringIO
  241.     >>> read_decimalnl_short(StringIO.StringIO("1234\\n56"))
  242.     1234
  243.  
  244.     >>> read_decimalnl_short(StringIO.StringIO("1234L\\n56"))
  245.     Traceback (most recent call last):
  246.     ...
  247.     ValueError: trailing \'L\' not allowed in \'1234L\'
  248.     '''
  249.     s = read_stringnl(f, decode = False, stripquotes = False)
  250.     if s.endswith('L'):
  251.         raise ValueError("trailing 'L' not allowed in %r" % s)
  252.     
  253.     if s == '00':
  254.         return False
  255.     elif s == '01':
  256.         return True
  257.     
  258.     
  259.     try:
  260.         return int(s)
  261.     except OverflowError:
  262.         return long(s)
  263.  
  264.  
  265.  
  266. def read_decimalnl_long(f):
  267.     '''
  268.     >>> import StringIO
  269.  
  270.     >>> read_decimalnl_long(StringIO.StringIO("1234\\n56"))
  271.     Traceback (most recent call last):
  272.     ...
  273.     ValueError: trailing \'L\' required in \'1234\'
  274.  
  275.     Someday the trailing \'L\' will probably go away from this output.
  276.  
  277.     >>> read_decimalnl_long(StringIO.StringIO("1234L\\n56"))
  278.     1234L
  279.  
  280.     >>> read_decimalnl_long(StringIO.StringIO("123456789012345678901234L\\n6"))
  281.     123456789012345678901234L
  282.     '''
  283.     s = read_stringnl(f, decode = False, stripquotes = False)
  284.     if not s.endswith('L'):
  285.         raise ValueError("trailing 'L' required in %r" % s)
  286.     
  287.     return long(s)
  288.  
  289. decimalnl_short = ArgumentDescriptor(name = 'decimalnl_short', n = UP_TO_NEWLINE, reader = read_decimalnl_short, doc = "A newline-terminated decimal integer literal.\n\n                          This never has a trailing 'L', and the integer fit\n                          in a short Python int on the box where the pickle\n                          was written -- but there's no guarantee it will fit\n                          in a short Python int on the box where the pickle\n                          is read.\n                          ")
  290. decimalnl_long = ArgumentDescriptor(name = 'decimalnl_long', n = UP_TO_NEWLINE, reader = read_decimalnl_long, doc = "A newline-terminated decimal integer literal.\n\n                         This has a trailing 'L', and can represent integers\n                         of any size.\n                         ")
  291.  
  292. def read_floatnl(f):
  293.     '''
  294.     >>> import StringIO
  295.     >>> read_floatnl(StringIO.StringIO("-1.25\\n6"))
  296.     -1.25
  297.     '''
  298.     s = read_stringnl(f, decode = False, stripquotes = False)
  299.     return float(s)
  300.  
  301. floatnl = ArgumentDescriptor(name = 'floatnl', n = UP_TO_NEWLINE, reader = read_floatnl, doc = "A newline-terminated decimal floating literal.\n\n              In general this requires 17 significant digits for roundtrip\n              identity, and pickling then unpickling infinities, NaNs, and\n              minus zero doesn't work across boxes, or on some boxes even\n              on itself (e.g., Windows can't read the strings it produces\n              for infinities or NaNs).\n              ")
  302.  
  303. def read_float8(f):
  304.     '''
  305.     >>> import StringIO, struct
  306.     >>> raw = struct.pack(">d", -1.25)
  307.     >>> raw
  308.     \'\\xbf\\xf4\\x00\\x00\\x00\\x00\\x00\\x00\'
  309.     >>> read_float8(StringIO.StringIO(raw + "\\n"))
  310.     -1.25
  311.     '''
  312.     data = f.read(8)
  313.     if len(data) == 8:
  314.         return _unpack('>d', data)[0]
  315.     
  316.     raise ValueError('not enough data in stream to read float8')
  317.  
  318. float8 = ArgumentDescriptor(name = 'float8', n = 8, reader = read_float8, doc = 'An 8-byte binary representation of a float, big-endian.\n\n             The format is unique to Python, and shared with the struct\n             module (format string \'>d\') "in theory" (the struct and cPickle\n             implementations don\'t share the code -- they should).  It\'s\n             strongly related to the IEEE-754 double format, and, in normal\n             cases, is in fact identical to the big-endian 754 double format.\n             On other boxes the dynamic range is limited to that of a 754\n             double, and "add a half and chop" rounding is used to reduce\n             the precision to 53 bits.  However, even on a 754 box,\n             infinities, NaNs, and minus zero may not be handled correctly\n             (may not survive roundtrip pickling intact).\n             ')
  319. from pickle import decode_long
  320.  
  321. def read_long1(f):
  322.     '''
  323.     >>> import StringIO
  324.     >>> read_long1(StringIO.StringIO("\\x00"))
  325.     0L
  326.     >>> read_long1(StringIO.StringIO("\\x02\\xff\\x00"))
  327.     255L
  328.     >>> read_long1(StringIO.StringIO("\\x02\\xff\\x7f"))
  329.     32767L
  330.     >>> read_long1(StringIO.StringIO("\\x02\\x00\\xff"))
  331.     -256L
  332.     >>> read_long1(StringIO.StringIO("\\x02\\x00\\x80"))
  333.     -32768L
  334.     '''
  335.     n = read_uint1(f)
  336.     data = f.read(n)
  337.     if len(data) != n:
  338.         raise ValueError('not enough data in stream to read long1')
  339.     
  340.     return decode_long(data)
  341.  
  342. long1 = ArgumentDescriptor(name = 'long1', n = TAKEN_FROM_ARGUMENT1, reader = read_long1, doc = "A binary long, little-endian, using 1-byte size.\n\n    This first reads one byte as an unsigned size, then reads that\n    many bytes and interprets them as a little-endian 2's-complement long.\n    If the size is 0, that's taken as a shortcut for the long 0L.\n    ")
  343.  
  344. def read_long4(f):
  345.     '''
  346.     >>> import StringIO
  347.     >>> read_long4(StringIO.StringIO("\\x02\\x00\\x00\\x00\\xff\\x00"))
  348.     255L
  349.     >>> read_long4(StringIO.StringIO("\\x02\\x00\\x00\\x00\\xff\\x7f"))
  350.     32767L
  351.     >>> read_long4(StringIO.StringIO("\\x02\\x00\\x00\\x00\\x00\\xff"))
  352.     -256L
  353.     >>> read_long4(StringIO.StringIO("\\x02\\x00\\x00\\x00\\x00\\x80"))
  354.     -32768L
  355.     >>> read_long1(StringIO.StringIO("\\x00\\x00\\x00\\x00"))
  356.     0L
  357.     '''
  358.     n = read_int4(f)
  359.     if n < 0:
  360.         raise ValueError('long4 byte count < 0: %d' % n)
  361.     
  362.     data = f.read(n)
  363.     if len(data) != n:
  364.         raise ValueError('not enough data in stream to read long4')
  365.     
  366.     return decode_long(data)
  367.  
  368. long4 = ArgumentDescriptor(name = 'long4', n = TAKEN_FROM_ARGUMENT4, reader = read_long4, doc = "A binary representation of a long, little-endian.\n\n    This first reads four bytes as a signed size (but requires the\n    size to be >= 0), then reads that many bytes and interprets them\n    as a little-endian 2's-complement long.  If the size is 0, that's taken\n    as a shortcut for the long 0L, although LONG1 should really be used\n    then instead (and in any case where # of bytes < 256).\n    ")
  369.  
  370. class StackObject(object):
  371.     __slots__ = ('name', 'obtype', 'doc')
  372.     
  373.     def __init__(self, name, obtype, doc):
  374.         if not isinstance(name, str):
  375.             raise AssertionError
  376.         self.name = name
  377.         if not isinstance(obtype, type) and isinstance(obtype, tuple):
  378.             raise AssertionError
  379.         if isinstance(obtype, tuple):
  380.             for contained in obtype:
  381.                 if not isinstance(contained, type):
  382.                     raise AssertionError
  383.             
  384.         
  385.         self.obtype = obtype
  386.         if not isinstance(doc, str):
  387.             raise AssertionError
  388.         self.doc = doc
  389.  
  390.     
  391.     def __repr__(self):
  392.         return self.name
  393.  
  394.  
  395. pyint = StackObject(name = 'int', obtype = int, doc = 'A short (as opposed to long) Python integer object.')
  396. pylong = StackObject(name = 'long', obtype = long, doc = 'A long (as opposed to short) Python integer object.')
  397. pyinteger_or_bool = StackObject(name = 'int_or_bool', obtype = (int, long, bool), doc = 'A Python integer object (short or long), or a Python bool.')
  398. pybool = StackObject(name = 'bool', obtype = (bool,), doc = 'A Python bool object.')
  399. pyfloat = StackObject(name = 'float', obtype = float, doc = 'A Python float object.')
  400. pystring = StackObject(name = 'str', obtype = str, doc = 'A Python string object.')
  401. pyunicode = StackObject(name = 'unicode', obtype = unicode, doc = 'A Python Unicode string object.')
  402. pynone = StackObject(name = 'None', obtype = type(None), doc = 'The Python None object.')
  403. pytuple = StackObject(name = 'tuple', obtype = tuple, doc = 'A Python tuple object.')
  404. pylist = StackObject(name = 'list', obtype = list, doc = 'A Python list object.')
  405. pydict = StackObject(name = 'dict', obtype = dict, doc = 'A Python dict object.')
  406. anyobject = StackObject(name = 'any', obtype = object, doc = 'Any kind of object whatsoever.')
  407. markobject = StackObject(name = 'mark', obtype = StackObject, doc = "'The mark' is a unique object.\n\n                 Opcodes that operate on a variable number of objects\n                 generally don't embed the count of objects in the opcode,\n                 or pull it off the stack.  Instead the MARK opcode is used\n                 to push a special marker object on the stack, and then\n                 some other opcodes grab all the objects from the top of\n                 the stack down to (but not including) the topmost marker\n                 object.\n                 ")
  408. stackslice = StackObject(name = 'stackslice', obtype = StackObject, doc = 'An object representing a contiguous slice of the stack.\n\n                 This is used in conjuction with markobject, to represent all\n                 of the stack following the topmost markobject.  For example,\n                 the POP_MARK opcode changes the stack from\n\n                     [..., markobject, stackslice]\n                 to\n                     [...]\n\n                 No matter how many object are on the stack after the topmost\n                 markobject, POP_MARK gets rid of all of them (including the\n                 topmost markobject too).\n                 ')
  409.  
  410. class OpcodeInfo(object):
  411.     __slots__ = ('name', 'code', 'arg', 'stack_before', 'stack_after', 'proto', 'doc')
  412.     
  413.     def __init__(self, name, code, arg, stack_before, stack_after, proto, doc):
  414.         if not isinstance(name, str):
  415.             raise AssertionError
  416.         self.name = name
  417.         if not isinstance(code, str):
  418.             raise AssertionError
  419.         if not len(code) == 1:
  420.             raise AssertionError
  421.         self.code = code
  422.         if not arg is None and isinstance(arg, ArgumentDescriptor):
  423.             raise AssertionError
  424.         self.arg = arg
  425.         if not isinstance(stack_before, list):
  426.             raise AssertionError
  427.         for x in stack_before:
  428.             if not isinstance(x, StackObject):
  429.                 raise AssertionError
  430.         
  431.         self.stack_before = stack_before
  432.         if not isinstance(stack_after, list):
  433.             raise AssertionError
  434.         for x in stack_after:
  435.             if not isinstance(x, StackObject):
  436.                 raise AssertionError
  437.         
  438.         self.stack_after = stack_after
  439.         if isinstance(proto, int):
  440.             if proto <= proto:
  441.                 pass
  442.             elif not proto <= 2:
  443.                 raise AssertionError
  444.         self.proto = proto
  445.         if not isinstance(doc, str):
  446.             raise AssertionError
  447.         self.doc = doc
  448.  
  449.  
  450. I = OpcodeInfo
  451. opcodes = [
  452.     I(name = 'INT', code = 'I', arg = decimalnl_short, stack_before = [], stack_after = [
  453.         pyinteger_or_bool], proto = 0, doc = 'Push an integer or bool.\n\n      The argument is a newline-terminated decimal literal string.\n\n      The intent may have been that this always fit in a short Python int,\n      but INT can be generated in pickles written on a 64-bit box that\n      require a Python long on a 32-bit box.  The difference between this\n      and LONG then is that INT skips a trailing \'L\', and produces a short\n      int whenever possible.\n\n      Another difference is due to that, when bool was introduced as a\n      distinct type in 2.3, builtin names True and False were also added to\n      2.2.2, mapping to ints 1 and 0.  For compatibility in both directions,\n      True gets pickled as INT + "I01\\n", and False as INT + "I00\\n".\n      Leading zeroes are never produced for a genuine integer.  The 2.3\n      (and later) unpicklers special-case these and return bool instead;\n      earlier unpicklers ignore the leading "0" and return the int.\n      '),
  454.     I(name = 'BININT', code = 'J', arg = int4, stack_before = [], stack_after = [
  455.         pyint], proto = 1, doc = 'Push a four-byte signed integer.\n\n      This handles the full range of Python (short) integers on a 32-bit\n      box, directly as binary bytes (1 for the opcode and 4 for the integer).\n      If the integer is non-negative and fits in 1 or 2 bytes, pickling via\n      BININT1 or BININT2 saves space.\n      '),
  456.     I(name = 'BININT1', code = 'K', arg = uint1, stack_before = [], stack_after = [
  457.         pyint], proto = 1, doc = 'Push a one-byte unsigned integer.\n\n      This is a space optimization for pickling very small non-negative ints,\n      in range(256).\n      '),
  458.     I(name = 'BININT2', code = 'M', arg = uint2, stack_before = [], stack_after = [
  459.         pyint], proto = 1, doc = 'Push a two-byte unsigned integer.\n\n      This is a space optimization for pickling small positive ints, in\n      range(256, 2**16).  Integers in range(256) can also be pickled via\n      BININT2, but BININT1 instead saves a byte.\n      '),
  460.     I(name = 'LONG', code = 'L', arg = decimalnl_long, stack_before = [], stack_after = [
  461.         pylong], proto = 0, doc = "Push a long integer.\n\n      The same as INT, except that the literal ends with 'L', and always\n      unpickles to a Python long.  There doesn't seem a real purpose to the\n      trailing 'L'.\n\n      Note that LONG takes time quadratic in the number of digits when\n      unpickling (this is simply due to the nature of decimal->binary\n      conversion).  Proto 2 added linear-time (in C; still quadratic-time\n      in Python) LONG1 and LONG4 opcodes.\n      "),
  462.     I(name = 'LONG1', code = '\x8a', arg = long1, stack_before = [], stack_after = [
  463.         pylong], proto = 2, doc = 'Long integer using one-byte length.\n\n      A more efficient encoding of a Python long; the long1 encoding\n      says it all.'),
  464.     I(name = 'LONG4', code = '\x8b', arg = long4, stack_before = [], stack_after = [
  465.         pylong], proto = 2, doc = 'Long integer using found-byte length.\n\n      A more efficient encoding of a Python long; the long4 encoding\n      says it all.'),
  466.     I(name = 'STRING', code = 'S', arg = stringnl, stack_before = [], stack_after = [
  467.         pystring], proto = 0, doc = 'Push a Python string object.\n\n      The argument is a repr-style string, with bracketing quote characters,\n      and perhaps embedded escapes.  The argument extends until the next\n      newline character.\n      '),
  468.     I(name = 'BINSTRING', code = 'T', arg = string4, stack_before = [], stack_after = [
  469.         pystring], proto = 1, doc = 'Push a Python string object.\n\n      There are two arguments:  the first is a 4-byte little-endian signed int\n      giving the number of bytes in the string, and the second is that many\n      bytes, which are taken literally as the string content.\n      '),
  470.     I(name = 'SHORT_BINSTRING', code = 'U', arg = string1, stack_before = [], stack_after = [
  471.         pystring], proto = 1, doc = 'Push a Python string object.\n\n      There are two arguments:  the first is a 1-byte unsigned int giving\n      the number of bytes in the string, and the second is that many bytes,\n      which are taken literally as the string content.\n      '),
  472.     I(name = 'NONE', code = 'N', arg = None, stack_before = [], stack_after = [
  473.         pynone], proto = 0, doc = 'Push None on the stack.'),
  474.     I(name = 'NEWTRUE', code = '\x88', arg = None, stack_before = [], stack_after = [
  475.         pybool], proto = 2, doc = 'True.\n\n      Push True onto the stack.'),
  476.     I(name = 'NEWFALSE', code = '\x89', arg = None, stack_before = [], stack_after = [
  477.         pybool], proto = 2, doc = 'True.\n\n      Push False onto the stack.'),
  478.     I(name = 'UNICODE', code = 'V', arg = unicodestringnl, stack_before = [], stack_after = [
  479.         pyunicode], proto = 0, doc = 'Push a Python Unicode string object.\n\n      The argument is a raw-unicode-escape encoding of a Unicode string,\n      and so may contain embedded escape sequences.  The argument extends\n      until the next newline character.\n      '),
  480.     I(name = 'BINUNICODE', code = 'X', arg = unicodestring4, stack_before = [], stack_after = [
  481.         pyunicode], proto = 1, doc = 'Push a Python Unicode string object.\n\n      There are two arguments:  the first is a 4-byte little-endian signed int\n      giving the number of bytes in the string.  The second is that many\n      bytes, and is the UTF-8 encoding of the Unicode string.\n      '),
  482.     I(name = 'FLOAT', code = 'F', arg = floatnl, stack_before = [], stack_after = [
  483.         pyfloat], proto = 0, doc = "Newline-terminated decimal float literal.\n\n      The argument is repr(a_float), and in general requires 17 significant\n      digits for roundtrip conversion to be an identity (this is so for\n      IEEE-754 double precision values, which is what Python float maps to\n      on most boxes).\n\n      In general, FLOAT cannot be used to transport infinities, NaNs, or\n      minus zero across boxes (or even on a single box, if the platform C\n      library can't read the strings it produces for such things -- Windows\n      is like that), but may do less damage than BINFLOAT on boxes with\n      greater precision or dynamic range than IEEE-754 double.\n      "),
  484.     I(name = 'BINFLOAT', code = 'G', arg = float8, stack_before = [], stack_after = [
  485.         pyfloat], proto = 1, doc = 'Float stored in binary form, with 8 bytes of data.\n\n      This generally requires less than half the space of FLOAT encoding.\n      In general, BINFLOAT cannot be used to transport infinities, NaNs, or\n      minus zero, raises an exception if the exponent exceeds the range of\n      an IEEE-754 double, and retains no more than 53 bits of precision (if\n      there are more than that, "add a half and chop" rounding is used to\n      cut it back to 53 significant bits).\n      '),
  486.     I(name = 'EMPTY_LIST', code = ']', arg = None, stack_before = [], stack_after = [
  487.         pylist], proto = 1, doc = 'Push an empty list.'),
  488.     I(name = 'APPEND', code = 'a', arg = None, stack_before = [
  489.         pylist,
  490.         anyobject], stack_after = [
  491.         pylist], proto = 0, doc = 'Append an object to a list.\n\n      Stack before:  ... pylist anyobject\n      Stack after:   ... pylist+[anyobject]\n\n      although pylist is really extended in-place.\n      '),
  492.     I(name = 'APPENDS', code = 'e', arg = None, stack_before = [
  493.         pylist,
  494.         markobject,
  495.         stackslice], stack_after = [
  496.         pylist], proto = 1, doc = 'Extend a list by a slice of stack objects.\n\n      Stack before:  ... pylist markobject stackslice\n      Stack after:   ... pylist+stackslice\n\n      although pylist is really extended in-place.\n      '),
  497.     I(name = 'LIST', code = 'l', arg = None, stack_before = [
  498.         markobject,
  499.         stackslice], stack_after = [
  500.         pylist], proto = 0, doc = "Build a list out of the topmost stack slice, after markobject.\n\n      All the stack entries following the topmost markobject are placed into\n      a single Python list, which single list object replaces all of the\n      stack from the topmost markobject onward.  For example,\n\n      Stack before: ... markobject 1 2 3 'abc'\n      Stack after:  ... [1, 2, 3, 'abc']\n      "),
  501.     I(name = 'EMPTY_TUPLE', code = ')', arg = None, stack_before = [], stack_after = [
  502.         pytuple], proto = 1, doc = 'Push an empty tuple.'),
  503.     I(name = 'TUPLE', code = 't', arg = None, stack_before = [
  504.         markobject,
  505.         stackslice], stack_after = [
  506.         pytuple], proto = 0, doc = "Build a tuple out of the topmost stack slice, after markobject.\n\n      All the stack entries following the topmost markobject are placed into\n      a single Python tuple, which single tuple object replaces all of the\n      stack from the topmost markobject onward.  For example,\n\n      Stack before: ... markobject 1 2 3 'abc'\n      Stack after:  ... (1, 2, 3, 'abc')\n      "),
  507.     I(name = 'TUPLE1', code = '\x85', arg = None, stack_before = [
  508.         anyobject], stack_after = [
  509.         pytuple], proto = 2, doc = 'One-tuple.\n\n      This code pops one value off the stack and pushes a tuple of\n      length 1 whose one item is that value back onto it.  IOW:\n\n          stack[-1] = tuple(stack[-1:])\n      '),
  510.     I(name = 'TUPLE2', code = '\x86', arg = None, stack_before = [
  511.         anyobject,
  512.         anyobject], stack_after = [
  513.         pytuple], proto = 2, doc = 'One-tuple.\n\n      This code pops two values off the stack and pushes a tuple\n      of length 2 whose items are those values back onto it.  IOW:\n\n          stack[-2:] = [tuple(stack[-2:])]\n      '),
  514.     I(name = 'TUPLE3', code = '\x87', arg = None, stack_before = [
  515.         anyobject,
  516.         anyobject,
  517.         anyobject], stack_after = [
  518.         pytuple], proto = 2, doc = 'One-tuple.\n\n      This code pops three values off the stack and pushes a tuple\n      of length 3 whose items are those values back onto it.  IOW:\n\n          stack[-3:] = [tuple(stack[-3:])]\n      '),
  519.     I(name = 'EMPTY_DICT', code = '}', arg = None, stack_before = [], stack_after = [
  520.         pydict], proto = 1, doc = 'Push an empty dict.'),
  521.     I(name = 'DICT', code = 'd', arg = None, stack_before = [
  522.         markobject,
  523.         stackslice], stack_after = [
  524.         pydict], proto = 0, doc = "Build a dict out of the topmost stack slice, after markobject.\n\n      All the stack entries following the topmost markobject are placed into\n      a single Python dict, which single dict object replaces all of the\n      stack from the topmost markobject onward.  The stack slice alternates\n      key, value, key, value, ....  For example,\n\n      Stack before: ... markobject 1 2 3 'abc'\n      Stack after:  ... {1: 2, 3: 'abc'}\n      "),
  525.     I(name = 'SETITEM', code = 's', arg = None, stack_before = [
  526.         pydict,
  527.         anyobject,
  528.         anyobject], stack_after = [
  529.         pydict], proto = 0, doc = 'Add a key+value pair to an existing dict.\n\n      Stack before:  ... pydict key value\n      Stack after:   ... pydict\n\n      where pydict has been modified via pydict[key] = value.\n      '),
  530.     I(name = 'SETITEMS', code = 'u', arg = None, stack_before = [
  531.         pydict,
  532.         markobject,
  533.         stackslice], stack_after = [
  534.         pydict], proto = 1, doc = 'Add an arbitrary number of key+value pairs to an existing dict.\n\n      The slice of the stack following the topmost markobject is taken as\n      an alternating sequence of keys and values, added to the dict\n      immediately under the topmost markobject.  Everything at and after the\n      topmost markobject is popped, leaving the mutated dict at the top\n      of the stack.\n\n      Stack before:  ... pydict markobject key_1 value_1 ... key_n value_n\n      Stack after:   ... pydict\n\n      where pydict has been modified via pydict[key_i] = value_i for i in\n      1, 2, ..., n, and in that order.\n      '),
  535.     I(name = 'POP', code = '0', arg = None, stack_before = [
  536.         anyobject], stack_after = [], proto = 0, doc = 'Discard the top stack item, shrinking the stack by one item.'),
  537.     I(name = 'DUP', code = '2', arg = None, stack_before = [
  538.         anyobject], stack_after = [
  539.         anyobject,
  540.         anyobject], proto = 0, doc = 'Push the top stack item onto the stack again, duplicating it.'),
  541.     I(name = 'MARK', code = '(', arg = None, stack_before = [], stack_after = [
  542.         markobject], proto = 0, doc = 'Push markobject onto the stack.\n\n      markobject is a unique object, used by other opcodes to identify a\n      region of the stack containing a variable number of objects for them\n      to work on.  See markobject.doc for more detail.\n      '),
  543.     I(name = 'POP_MARK', code = '1', arg = None, stack_before = [
  544.         markobject,
  545.         stackslice], stack_after = [], proto = 0, doc = 'Pop all the stack objects at and above the topmost markobject.\n\n      When an opcode using a variable number of stack objects is done,\n      POP_MARK is used to remove those objects, and to remove the markobject\n      that delimited their starting position on the stack.\n      '),
  546.     I(name = 'GET', code = 'g', arg = decimalnl_short, stack_before = [], stack_after = [
  547.         anyobject], proto = 0, doc = 'Read an object from the memo and push it on the stack.\n\n      The index of the memo object to push is given by the newline-teriminated\n      decimal string following.  BINGET and LONG_BINGET are space-optimized\n      versions.\n      '),
  548.     I(name = 'BINGET', code = 'h', arg = uint1, stack_before = [], stack_after = [
  549.         anyobject], proto = 1, doc = 'Read an object from the memo and push it on the stack.\n\n      The index of the memo object to push is given by the 1-byte unsigned\n      integer following.\n      '),
  550.     I(name = 'LONG_BINGET', code = 'j', arg = int4, stack_before = [], stack_after = [
  551.         anyobject], proto = 1, doc = 'Read an object from the memo and push it on the stack.\n\n      The index of the memo object to push is given by the 4-byte signed\n      little-endian integer following.\n      '),
  552.     I(name = 'PUT', code = 'p', arg = decimalnl_short, stack_before = [], stack_after = [], proto = 0, doc = 'Store the stack top into the memo.  The stack is not popped.\n\n      The index of the memo location to write into is given by the newline-\n      terminated decimal string following.  BINPUT and LONG_BINPUT are\n      space-optimized versions.\n      '),
  553.     I(name = 'BINPUT', code = 'q', arg = uint1, stack_before = [], stack_after = [], proto = 1, doc = 'Store the stack top into the memo.  The stack is not popped.\n\n      The index of the memo location to write into is given by the 1-byte\n      unsigned integer following.\n      '),
  554.     I(name = 'LONG_BINPUT', code = 'r', arg = int4, stack_before = [], stack_after = [], proto = 1, doc = 'Store the stack top into the memo.  The stack is not popped.\n\n      The index of the memo location to write into is given by the 4-byte\n      signed little-endian integer following.\n      '),
  555.     I(name = 'EXT1', code = '\x82', arg = uint1, stack_before = [], stack_after = [
  556.         anyobject], proto = 2, doc = 'Extension code.\n\n      This code and the similar EXT2 and EXT4 allow using a registry\n      of popular objects that are pickled by name, typically classes.\n      It is envisioned that through a global negotiation and\n      registration process, third parties can set up a mapping between\n      ints and object names.\n\n      In order to guarantee pickle interchangeability, the extension\n      code registry ought to be global, although a range of codes may\n      be reserved for private use.\n\n      EXT1 has a 1-byte integer argument.  This is used to index into the\n      extension registry, and the object at that index is pushed on the stack.\n      '),
  557.     I(name = 'EXT2', code = '\x83', arg = uint2, stack_before = [], stack_after = [
  558.         anyobject], proto = 2, doc = 'Extension code.\n\n      See EXT1.  EXT2 has a two-byte integer argument.\n      '),
  559.     I(name = 'EXT4', code = '\x84', arg = int4, stack_before = [], stack_after = [
  560.         anyobject], proto = 2, doc = 'Extension code.\n\n      See EXT1.  EXT4 has a four-byte integer argument.\n      '),
  561.     I(name = 'GLOBAL', code = 'c', arg = stringnl_noescape_pair, stack_before = [], stack_after = [
  562.         anyobject], proto = 0, doc = 'Push a global object (module.attr) on the stack.\n\n      Two newline-terminated strings follow the GLOBAL opcode.  The first is\n      taken as a module name, and the second as a class name.  The class\n      object module.class is pushed on the stack.  More accurately, the\n      object returned by self.find_class(module, class) is pushed on the\n      stack, so unpickling subclasses can override this form of lookup.\n      '),
  563.     I(name = 'REDUCE', code = 'R', arg = None, stack_before = [
  564.         anyobject,
  565.         anyobject], stack_after = [
  566.         anyobject], proto = 0, doc = "Push an object built from a callable and an argument tuple.\n\n      The opcode is named to remind of the __reduce__() method.\n\n      Stack before: ... callable pytuple\n      Stack after:  ... callable(*pytuple)\n\n      The callable and the argument tuple are the first two items returned\n      by a __reduce__ method.  Applying the callable to the argtuple is\n      supposed to reproduce the original object, or at least get it started.\n      If the __reduce__ method returns a 3-tuple, the last component is an\n      argument to be passed to the object's __setstate__, and then the REDUCE\n      opcode is followed by code to create setstate's argument, and then a\n      BUILD opcode to apply  __setstate__ to that argument.\n\n      There are lots of special cases here.  The argtuple can be None, in\n      which case callable.__basicnew__() is called instead to produce the\n      object to be pushed on the stack.  This appears to be a trick unique\n      to ExtensionClasses, and is deprecated regardless.\n\n      If type(callable) is not ClassType, REDUCE complains unless the\n      callable has been registered with the copy_reg module's\n      safe_constructors dict, or the callable has a magic\n      '__safe_for_unpickling__' attribute with a true value.  I'm not sure\n      why it does this, but I've sure seen this complaint often enough when\n      I didn't want to <wink>.\n      "),
  567.     I(name = 'BUILD', code = 'b', arg = None, stack_before = [
  568.         anyobject,
  569.         anyobject], stack_after = [
  570.         anyobject], proto = 0, doc = 'Finish building an object, via __setstate__ or dict update.\n\n      Stack before: ... anyobject argument\n      Stack after:  ... anyobject\n\n      where anyobject may have been mutated, as follows:\n\n      If the object has a __setstate__ method,\n\n          anyobject.__setstate__(argument)\n\n      is called.\n\n      Else the argument must be a dict, the object must have a __dict__, and\n      the object is updated via\n\n          anyobject.__dict__.update(argument)\n\n      This may raise RuntimeError in restricted execution mode (which\n      disallows access to __dict__ directly); in that case, the object\n      is updated instead via\n\n          for k, v in argument.items():\n              anyobject[k] = v\n      '),
  571.     I(name = 'INST', code = 'i', arg = stringnl_noescape_pair, stack_before = [
  572.         markobject,
  573.         stackslice], stack_after = [
  574.         anyobject], proto = 0, doc = "Build a class instance.\n\n      This is the protocol 0 version of protocol 1's OBJ opcode.\n      INST is followed by two newline-terminated strings, giving a\n      module and class name, just as for the GLOBAL opcode (and see\n      GLOBAL for more details about that).  self.find_class(module, name)\n      is used to get a class object.\n\n      In addition, all the objects on the stack following the topmost\n      markobject are gathered into a tuple and popped (along with the\n      topmost markobject), just as for the TUPLE opcode.\n\n      Now it gets complicated.  If all of these are true:\n\n        + The argtuple is empty (markobject was at the top of the stack\n          at the start).\n\n        + It's an old-style class object (the type of the class object is\n          ClassType).\n\n        + The class object does not have a __getinitargs__ attribute.\n\n      then we want to create an old-style class instance without invoking\n      its __init__() method (pickle has waffled on this over the years; not\n      calling __init__() is current wisdom).  In this case, an instance of\n      an old-style dummy class is created, and then we try to rebind its\n      __class__ attribute to the desired class object.  If this succeeds,\n      the new instance object is pushed on the stack, and we're done.  In\n      restricted execution mode it can fail (assignment to __class__ is\n      disallowed), and I'm not really sure what happens then -- it looks\n      like the code ends up calling the class object's __init__ anyway,\n      via falling into the next case.\n\n      Else (the argtuple is not empty, it's not an old-style class object,\n      or the class object does have a __getinitargs__ attribute), the code\n      first insists that the class object have a __safe_for_unpickling__\n      attribute.  Unlike as for the __safe_for_unpickling__ check in REDUCE,\n      it doesn't matter whether this attribute has a true or false value, it\n      only matters whether it exists (XXX this is a bug; cPickle\n      requires the attribute to be true).  If __safe_for_unpickling__\n      doesn't exist, UnpicklingError is raised.\n\n      Else (the class object does have a __safe_for_unpickling__ attr),\n      the class object obtained from INST's arguments is applied to the\n      argtuple obtained from the stack, and the resulting instance object\n      is pushed on the stack.\n\n      NOTE:  checks for __safe_for_unpickling__ went away in Python 2.3.\n      "),
  575.     I(name = 'OBJ', code = 'o', arg = None, stack_before = [
  576.         markobject,
  577.         anyobject,
  578.         stackslice], stack_after = [
  579.         anyobject], proto = 1, doc = "Build a class instance.\n\n      This is the protocol 1 version of protocol 0's INST opcode, and is\n      very much like it.  The major difference is that the class object\n      is taken off the stack, allowing it to be retrieved from the memo\n      repeatedly if several instances of the same class are created.  This\n      can be much more efficient (in both time and space) than repeatedly\n      embedding the module and class names in INST opcodes.\n\n      Unlike INST, OBJ takes no arguments from the opcode stream.  Instead\n      the class object is taken off the stack, immediately above the\n      topmost markobject:\n\n      Stack before: ... markobject classobject stackslice\n      Stack after:  ... new_instance_object\n\n      As for INST, the remainder of the stack above the markobject is\n      gathered into an argument tuple, and then the logic seems identical,\n      except that no __safe_for_unpickling__ check is done (XXX this is\n      a bug; cPickle does test __safe_for_unpickling__).  See INST for\n      the gory details.\n\n      NOTE:  In Python 2.3, INST and OBJ are identical except for how they\n      get the class object.  That was always the intent; the implementations\n      had diverged for accidental reasons.\n      "),
  580.     I(name = 'NEWOBJ', code = '\x81', arg = None, stack_before = [
  581.         anyobject,
  582.         anyobject], stack_after = [
  583.         anyobject], proto = 2, doc = 'Build an object instance.\n\n      The stack before should be thought of as containing a class\n      object followed by an argument tuple (the tuple being the stack\n      top).  Call these cls and args.  They are popped off the stack,\n      and the value returned by cls.__new__(cls, *args) is pushed back\n      onto the stack.\n      '),
  584.     I(name = 'PROTO', code = '\x80', arg = uint1, stack_before = [], stack_after = [], proto = 2, doc = 'Protocol version indicator.\n\n      For protocol 2 and above, a pickle must start with this opcode.\n      The argument is the protocol version, an int in range(2, 256).\n      '),
  585.     I(name = 'STOP', code = '.', arg = None, stack_before = [
  586.         anyobject], stack_after = [], proto = 0, doc = "Stop the unpickling machine.\n\n      Every pickle ends with this opcode.  The object at the top of the stack\n      is popped, and that's the result of unpickling.  The stack should be\n      empty then.\n      "),
  587.     I(name = 'PERSID', code = 'P', arg = stringnl_noescape, stack_before = [], stack_after = [
  588.         anyobject], proto = 0, doc = 'Push an object identified by a persistent ID.\n\n      The pickle module doesn\'t define what a persistent ID means.  PERSID\'s\n      argument is a newline-terminated str-style (no embedded escapes, no\n      bracketing quote characters) string, which *is* "the persistent ID".\n      The unpickler passes this string to self.persistent_load().  Whatever\n      object that returns is pushed on the stack.  There is no implementation\n      of persistent_load() in Python\'s unpickler:  it must be supplied by an\n      unpickler subclass.\n      '),
  589.     I(name = 'BINPERSID', code = 'Q', arg = None, stack_before = [
  590.         anyobject], stack_after = [
  591.         anyobject], proto = 1, doc = 'Push an object identified by a persistent ID.\n\n      Like PERSID, except the persistent ID is popped off the stack (instead\n      of being a string embedded in the opcode bytestream).  The persistent\n      ID is passed to self.persistent_load(), and whatever object that\n      returns is pushed on the stack.  See PERSID for more detail.\n      ')]
  592. del I
  593. name2i = { }
  594. code2i = { }
  595. for i, d in enumerate(opcodes):
  596.     if d.name in name2i:
  597.         raise ValueError('repeated name %r at indices %d and %d' % (d.name, name2i[d.name], i))
  598.     
  599.     if d.code in code2i:
  600.         raise ValueError('repeated code %r at indices %d and %d' % (d.code, code2i[d.code], i))
  601.     
  602.     name2i[d.name] = i
  603.     code2i[d.code] = i
  604.  
  605. del name2i
  606. del code2i
  607. del i
  608. del d
  609. code2op = { }
  610. for d in opcodes:
  611.     code2op[d.code] = d
  612.  
  613. del d
  614.  
  615. def assure_pickle_consistency(verbose = False):
  616.     import pickle as pickle
  617.     import re as re
  618.     copy = code2op.copy()
  619.     for name in pickle.__all__:
  620.         if not re.match('[A-Z][A-Z0-9_]+$', name):
  621.             if verbose:
  622.                 print "skipping %r: it doesn't look like an opcode name" % name
  623.                 continue
  624.             continue
  625.         
  626.         picklecode = getattr(pickle, name)
  627.         if not isinstance(picklecode, str) or len(picklecode) != 1:
  628.             if verbose:
  629.                 print "skipping %r: value %r doesn't look like a pickle code" % (name, picklecode)
  630.                 continue
  631.             continue
  632.         
  633.         if picklecode in copy:
  634.             if verbose:
  635.                 print 'checking name %r w/ code %r for consistency' % (name, picklecode)
  636.             
  637.             d = copy[picklecode]
  638.             if d.name != name:
  639.                 raise ValueError("for pickle code %r, pickle.py uses name %r but we're using name %r" % (picklecode, name, d.name))
  640.             
  641.             del copy[picklecode]
  642.             continue
  643.         raise ValueError("pickle.py appears to have a pickle opcode with name %r and code %r, but we don't" % (name, picklecode))
  644.     
  645.     if copy:
  646.         msg = [
  647.             "we appear to have pickle opcodes that pickle.py doesn't have:"]
  648.         for code, d in copy.items():
  649.             msg.append('    name %r with code %r' % (d.name, code))
  650.         
  651.         raise ValueError('\n'.join(msg))
  652.     
  653.  
  654. assure_pickle_consistency()
  655. del assure_pickle_consistency
  656.  
  657. def genops(pickle):
  658.     """Generate all the opcodes in a pickle.
  659.  
  660.     'pickle' is a file-like object, or string, containing the pickle.
  661.  
  662.     Each opcode in the pickle is generated, from the current pickle position,
  663.     stopping after a STOP opcode is delivered.  A triple is generated for
  664.     each opcode:
  665.  
  666.         opcode, arg, pos
  667.  
  668.     opcode is an OpcodeInfo record, describing the current opcode.
  669.  
  670.     If the opcode has an argument embedded in the pickle, arg is its decoded
  671.     value, as a Python object.  If the opcode doesn't have an argument, arg
  672.     is None.
  673.  
  674.     If the pickle has a tell() method, pos was the value of pickle.tell()
  675.     before reading the current opcode.  If the pickle is a string object,
  676.     it's wrapped in a StringIO object, and the latter's tell() result is
  677.     used.  Else (the pickle doesn't have a tell(), and it's not obvious how
  678.     to query its current position) pos is None.
  679.     """
  680.     import cStringIO as StringIO
  681.     if isinstance(pickle, str):
  682.         pickle = StringIO.StringIO(pickle)
  683.     
  684.     if hasattr(pickle, 'tell'):
  685.         getpos = pickle.tell
  686.     else:
  687.         
  688.         getpos = lambda : pass
  689.     while True:
  690.         pos = getpos()
  691.         code = pickle.read(1)
  692.         opcode = code2op.get(code)
  693.         if opcode is None:
  694.             raise None(ValueError % ('at position %s, opcode %r unknown' if code == '' else pos, code))
  695.         
  696.         if opcode.arg is None:
  697.             arg = None
  698.         else:
  699.             arg = opcode.arg.reader(pickle)
  700.         yield (opcode, arg, pos)
  701.         if code == '.':
  702.             if not opcode.name == 'STOP':
  703.                 raise AssertionError
  704.             break
  705.             continue
  706.  
  707.  
  708. def dis(pickle, out = None, memo = None, indentlevel = 4):
  709.     '''Produce a symbolic disassembly of a pickle.
  710.  
  711.     \'pickle\' is a file-like object, or string, containing a (at least one)
  712.     pickle.  The pickle is disassembled from the current position, through
  713.     the first STOP opcode encountered.
  714.  
  715.     Optional arg \'out\' is a file-like object to which the disassembly is
  716.     printed.  It defaults to sys.stdout.
  717.  
  718.     Optional arg \'memo\' is a Python dict, used as the pickle\'s memo.  It
  719.     may be mutated by dis(), if the pickle contains PUT or BINPUT opcodes.
  720.     Passing the same memo object to another dis() call then allows disassembly
  721.     to proceed across multiple pickles that were all created by the same
  722.     pickler with the same memo.  Ordinarily you don\'t need to worry about this.
  723.  
  724.     Optional arg indentlevel is the number of blanks by which to indent
  725.     a new MARK level.  It defaults to 4.
  726.  
  727.     In addition to printing the disassembly, some sanity checks are made:
  728.  
  729.     + All embedded opcode arguments "make sense".
  730.  
  731.     + Explicit and implicit pop operations have enough items on the stack.
  732.  
  733.     + When an opcode implicitly refers to a markobject, a markobject is
  734.       actually on the stack.
  735.  
  736.     + A memo entry isn\'t referenced before it\'s defined.
  737.  
  738.     + The markobject isn\'t stored in the memo.
  739.  
  740.     + A memo entry isn\'t redefined.
  741.     '''
  742.     stack = []
  743.     if memo is None:
  744.         memo = { }
  745.     
  746.     maxproto = -1
  747.     markstack = []
  748.     indentchunk = ' ' * indentlevel
  749.     errormsg = None
  750.     for opcode, arg, pos in genops(pickle):
  751.         if pos is not None:
  752.             print >>out, '%5d:' % pos,
  753.         
  754.         line = '%-4s %s%s' % (repr(opcode.code)[1:-1], indentchunk * len(markstack), opcode.name)
  755.         maxproto = max(maxproto, opcode.proto)
  756.         before = opcode.stack_before
  757.         after = opcode.stack_after
  758.         numtopop = len(before)
  759.         markmsg = None
  760.         if (markobject in before or opcode.name == 'POP') and stack and stack[-1] is markobject:
  761.             if not markobject not in after:
  762.                 raise AssertionError
  763.             if __debug__:
  764.                 if markobject in before:
  765.                     if not before[-1] is stackslice:
  766.                         raise AssertionError
  767.                 
  768.             
  769.             if markstack:
  770.                 markpos = markstack.pop()
  771.                 if markpos is None:
  772.                     markmsg = '(MARK at unknown opcode offset)'
  773.                 else:
  774.                     markmsg = '(MARK at %d)' % markpos
  775.                 while stack[-1] is not markobject:
  776.                     stack.pop()
  777.                 stack.pop()
  778.                 
  779.                 try:
  780.                     numtopop = before.index(markobject)
  781.                 except ValueError:
  782.                     if not opcode.name == 'POP':
  783.                         raise AssertionError
  784.                     numtopop = 0
  785.                 except:
  786.                     None<EXCEPTION MATCH>ValueError
  787.                 
  788.  
  789.             None<EXCEPTION MATCH>ValueError
  790.             errormsg = markmsg = 'no MARK exists on stack'
  791.         
  792.         if opcode.name in ('PUT', 'BINPUT', 'LONG_BINPUT'):
  793.             if not arg is not None:
  794.                 raise AssertionError
  795.             if arg in memo:
  796.                 errormsg = 'memo key %r already defined' % arg
  797.             elif not stack:
  798.                 errormsg = "stack is empty -- can't store into memo"
  799.             elif stack[-1] is markobject:
  800.                 errormsg = "can't store markobject in the memo"
  801.             else:
  802.                 memo[arg] = stack[-1]
  803.         elif opcode.name in ('GET', 'BINGET', 'LONG_BINGET'):
  804.             if arg in memo:
  805.                 if not len(after) == 1:
  806.                     raise AssertionError
  807.                 after = [
  808.                     memo[arg]]
  809.             else:
  810.                 errormsg = 'memo key %r has never been stored into' % arg
  811.         
  812.         if arg is not None or markmsg:
  813.             line += ' ' * (10 - len(opcode.name))
  814.             if arg is not None:
  815.                 line += ' ' + repr(arg)
  816.             
  817.             if markmsg:
  818.                 line += ' ' + markmsg
  819.             
  820.         
  821.         print >>out, line
  822.         if errormsg:
  823.             raise ValueError(errormsg)
  824.         
  825.         if len(stack) < numtopop:
  826.             raise ValueError('tries to pop %d items from stack with only %d items' % (numtopop, len(stack)))
  827.         
  828.         if numtopop:
  829.             del stack[-numtopop:]
  830.         
  831.         if markobject in after:
  832.             if not markobject not in before:
  833.                 raise AssertionError
  834.             markstack.append(pos)
  835.         
  836.         stack.extend(after)
  837.     
  838.     print >>out, 'highest protocol among opcodes =', maxproto
  839.     if stack:
  840.         raise ValueError('stack not empty after STOP: %r' % stack)
  841.     
  842.  
  843. _dis_test = '\n>>> import pickle\n>>> x = [1, 2, (3, 4), {\'abc\': u"def"}]\n>>> pkl = pickle.dumps(x, 0)\n>>> dis(pkl)\n    0: (    MARK\n    1: l        LIST       (MARK at 0)\n    2: p    PUT        0\n    5: I    INT        1\n    8: a    APPEND\n    9: I    INT        2\n   12: a    APPEND\n   13: (    MARK\n   14: I        INT        3\n   17: I        INT        4\n   20: t        TUPLE      (MARK at 13)\n   21: p    PUT        1\n   24: a    APPEND\n   25: (    MARK\n   26: d        DICT       (MARK at 25)\n   27: p    PUT        2\n   30: S    STRING     \'abc\'\n   37: p    PUT        3\n   40: V    UNICODE    u\'def\'\n   45: p    PUT        4\n   48: s    SETITEM\n   49: a    APPEND\n   50: .    STOP\nhighest protocol among opcodes = 0\n\nTry again with a "binary" pickle.\n\n>>> pkl = pickle.dumps(x, 1)\n>>> dis(pkl)\n    0: ]    EMPTY_LIST\n    1: q    BINPUT     0\n    3: (    MARK\n    4: K        BININT1    1\n    6: K        BININT1    2\n    8: (        MARK\n    9: K            BININT1    3\n   11: K            BININT1    4\n   13: t            TUPLE      (MARK at 8)\n   14: q        BINPUT     1\n   16: }        EMPTY_DICT\n   17: q        BINPUT     2\n   19: U        SHORT_BINSTRING \'abc\'\n   24: q        BINPUT     3\n   26: X        BINUNICODE u\'def\'\n   34: q        BINPUT     4\n   36: s        SETITEM\n   37: e        APPENDS    (MARK at 3)\n   38: .    STOP\nhighest protocol among opcodes = 1\n\nExercise the INST/OBJ/BUILD family.\n\n>>> import random\n>>> dis(pickle.dumps(random.random, 0))\n    0: c    GLOBAL     \'random random\'\n   15: p    PUT        0\n   18: .    STOP\nhighest protocol among opcodes = 0\n\n>>> x = [pickle.PicklingError()] * 2\n>>> dis(pickle.dumps(x, 0))\n    0: (    MARK\n    1: l        LIST       (MARK at 0)\n    2: p    PUT        0\n    5: (    MARK\n    6: i        INST       \'pickle PicklingError\' (MARK at 5)\n   28: p    PUT        1\n   31: (    MARK\n   32: d        DICT       (MARK at 31)\n   33: p    PUT        2\n   36: S    STRING     \'args\'\n   44: p    PUT        3\n   47: (    MARK\n   48: t        TUPLE      (MARK at 47)\n   49: s    SETITEM\n   50: b    BUILD\n   51: a    APPEND\n   52: g    GET        1\n   55: a    APPEND\n   56: .    STOP\nhighest protocol among opcodes = 0\n\n>>> dis(pickle.dumps(x, 1))\n    0: ]    EMPTY_LIST\n    1: q    BINPUT     0\n    3: (    MARK\n    4: (        MARK\n    5: c            GLOBAL     \'pickle PicklingError\'\n   27: q            BINPUT     1\n   29: o            OBJ        (MARK at 4)\n   30: q        BINPUT     2\n   32: }        EMPTY_DICT\n   33: q        BINPUT     3\n   35: U        SHORT_BINSTRING \'args\'\n   41: q        BINPUT     4\n   43: )        EMPTY_TUPLE\n   44: s        SETITEM\n   45: b        BUILD\n   46: h        BINGET     2\n   48: e        APPENDS    (MARK at 3)\n   49: .    STOP\nhighest protocol among opcodes = 1\n\nTry "the canonical" recursive-object test.\n\n>>> L = []\n>>> T = L,\n>>> L.append(T)\n>>> L[0] is T\nTrue\n>>> T[0] is L\nTrue\n>>> L[0][0] is L\nTrue\n>>> T[0][0] is T\nTrue\n>>> dis(pickle.dumps(L, 0))\n    0: (    MARK\n    1: l        LIST       (MARK at 0)\n    2: p    PUT        0\n    5: (    MARK\n    6: g        GET        0\n    9: t        TUPLE      (MARK at 5)\n   10: p    PUT        1\n   13: a    APPEND\n   14: .    STOP\nhighest protocol among opcodes = 0\n\n>>> dis(pickle.dumps(L, 1))\n    0: ]    EMPTY_LIST\n    1: q    BINPUT     0\n    3: (    MARK\n    4: h        BINGET     0\n    6: t        TUPLE      (MARK at 3)\n    7: q    BINPUT     1\n    9: a    APPEND\n   10: .    STOP\nhighest protocol among opcodes = 1\n\nNote that, in the protocol 0 pickle of the recursive tuple, the disassembler\nhas to emulate the stack in order to realize that the POP opcode at 16 gets\nrid of the MARK at 0.\n\n>>> dis(pickle.dumps(T, 0))\n    0: (    MARK\n    1: (        MARK\n    2: l            LIST       (MARK at 1)\n    3: p        PUT        0\n    6: (        MARK\n    7: g            GET        0\n   10: t            TUPLE      (MARK at 6)\n   11: p        PUT        1\n   14: a        APPEND\n   15: 0        POP\n   16: 0        POP        (MARK at 0)\n   17: g    GET        1\n   20: .    STOP\nhighest protocol among opcodes = 0\n\n>>> dis(pickle.dumps(T, 1))\n    0: (    MARK\n    1: ]        EMPTY_LIST\n    2: q        BINPUT     0\n    4: (        MARK\n    5: h            BINGET     0\n    7: t            TUPLE      (MARK at 4)\n    8: q        BINPUT     1\n   10: a        APPEND\n   11: 1        POP_MARK   (MARK at 0)\n   12: h    BINGET     1\n   14: .    STOP\nhighest protocol among opcodes = 1\n\nTry protocol 2.\n\n>>> dis(pickle.dumps(L, 2))\n    0: \\x80 PROTO      2\n    2: ]    EMPTY_LIST\n    3: q    BINPUT     0\n    5: h    BINGET     0\n    7: \\x85 TUPLE1\n    8: q    BINPUT     1\n   10: a    APPEND\n   11: .    STOP\nhighest protocol among opcodes = 2\n\n>>> dis(pickle.dumps(T, 2))\n    0: \\x80 PROTO      2\n    2: ]    EMPTY_LIST\n    3: q    BINPUT     0\n    5: h    BINGET     0\n    7: \\x85 TUPLE1\n    8: q    BINPUT     1\n   10: a    APPEND\n   11: 0    POP\n   12: h    BINGET     1\n   14: .    STOP\nhighest protocol among opcodes = 2\n'
  844. _memo_test = '\n>>> import pickle\n>>> from StringIO import StringIO\n>>> f = StringIO()\n>>> p = pickle.Pickler(f, 2)\n>>> x = [1, 2, 3]\n>>> p.dump(x)\n>>> p.dump(x)\n>>> f.seek(0)\n>>> memo = {}\n>>> dis(f, memo=memo)\n    0: \\x80 PROTO      2\n    2: ]    EMPTY_LIST\n    3: q    BINPUT     0\n    5: (    MARK\n    6: K        BININT1    1\n    8: K        BININT1    2\n   10: K        BININT1    3\n   12: e        APPENDS    (MARK at 5)\n   13: .    STOP\nhighest protocol among opcodes = 2\n>>> dis(f, memo=memo)\n   14: \\x80 PROTO      2\n   16: h    BINGET     0\n   18: .    STOP\nhighest protocol among opcodes = 2\n'
  845. __test__ = {
  846.     'disassembler_test': _dis_test,
  847.     'disassembler_memo_test': _memo_test }
  848.  
  849. def _test():
  850.     import doctest as doctest
  851.     return doctest.testmod()
  852.  
  853. if __name__ == '__main__':
  854.     _test()
  855.  
  856.